Features for diffing openapi-compatible json specs. #2

jaychang99 · 2024-05-25T12:26:50Z

No description provided.

github-actions · 2024-05-25T13:04:18Z

This is a multi-line test comment

With GitHub Markdown ✨
Created by create-or-update-comment
and testing openapi diff

github-actions · 2024-05-25T13:12:19Z

This is a multi-line test comment

With GitHub Markdown ✨
Created by create-or-update-comment
and testing openapi diff

github-actions · 2024-05-25T13:14:40Z

This is a multi-line test comment

With GitHub Markdown ✨
Created by create-or-update-comment
and testing openapi diff

github-actions · 2024-05-25T13:28:24Z

This is a multi-line test comment

With GitHub Markdown ✨
Created by create-or-update-comment
and testing openapi diff

This is a multi-line string

API Differences

ADDED

MODIFIED

DELETED

github-actions · 2024-05-25T23:26:16Z

This is a multi-line test comment

With GitHub Markdown ✨
Created by create-or-update-comment
and testing openapi diff

This is a multi-line string

API Differences

ADDED

MODIFIED

DELETED

github-actions · 2024-05-25T23:34:46Z

This is a multi-line test comment

With GitHub Markdown ✨
Created by create-or-update-comment
and testing openapi diff

This is a multi-line string

API Differences

ADDED

MODIFIED

DELETED

github-actions · 2024-05-26T00:18:38Z

This is a multi-line test comment

With GitHub Markdown ✨
Created by create-or-update-comment
and testing openapi diff

This is a multi-line string

API Differences

ADDED

MODIFIED

DELETED

github-actions · 2024-05-26T00:25:09Z

This is a multi-line test comment

With GitHub Markdown ✨
Created by create-or-update-comment
and testing openapi diff

This is a multi-line string

API Differences

ADDED

MODIFIED

DELETED

github-actions · 2024-05-26T00:56:35Z

This is a multi-line test comment

With GitHub Markdown ✨
Created by [create-or-update-comment][1]
and testing openapi diff
{
"components": {
"schemas": {
"CreateCatDto": {
"properties": {
"name": {
"type": "string"
},
"age": {
"type": "number"
}
},
"required": [
"name",
"age"
]
}
}
}
}
[1]: https://github.com/peter-evans/create-or-update-comment

…ript file

…d ref

…rvices

…y around

github-actions · 2024-05-26T05:41:22Z

This is a multi-line test comment

With GitHub Markdown ✨
Created by [create-or-update-comment][1]
and testing openapi diff
{
"components": {
"schemas": {
"CreateCatDto": {
"properties": {
"name": {
"type": "string"
},
"age": {
"type": "number"
}
},
"required": [
"name",
"age"
]
}
}
}
}
[1]: https://github.com/peter-evans/create-or-update-comment

github-actions · 2024-05-26T05:44:11Z

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🗑❌ Removed Endpoints

github-actions · 2024-05-26T07:29:04Z

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🟩 POST: /cats

undefined
undefined

Response Parameters

🗑❌ Removed Endpoints

github-actions · 2024-05-26T09:21:29Z

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🟩 POST: /cats

undefined
undefined

Response Parameters

🗑❌ Removed Endpoints

github-actions · 2024-05-26T09:30:25Z

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🟩 POST: /cats

Summary: Not Provided
Description: Not Provided

Response Parameters

🗑❌ Removed Endpoints

… provided for request bodies

…ma's type

github-actions · 2024-05-26T10:10:28Z

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🟩 POST: /cats

Summary: Not Provided
Description: Not Provided

Request Body

Content-Type: application/json
Description: Not Provided
Example: Not Provided
Content Required: true

name : string; REQUIRED 🔥 
📎Description Not Provided 
📚EX) Example Not Provided 

age : number; REQUIRED 🔥 
📎Description Not Provided 
📚EX) Example Not Provided

Response Parameters

🗑❌ Removed Endpoints

github-actions · 2024-05-26T10:44:45Z

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🟩 POST: /cats

Summary: Not Provided
Description: Not Provided

Request Body

Content-Type: application/json
Description: Not Provided
Example: Not Provided
Content Required: true

name : string; REQUIRED 🔥 
📎Description Not Provided 
📚EX) Example Not Provided 

age : number; REQUIRED 🔥 
📎Description Not Provided 
📚EX) Example Not Provided

🗑❌ Removed Endpoints

jaychang99 added 21 commits May 26, 2024 14:40

chore: change CODEOWNERS

0b95102

feat: add console.log to run function

88d5154

feat: creating comment in PRs and issues for test purposes

befe255

feat: testing posting comments on PR feature

edfee4a

fix: upgrade peter-evans library from v1 to v4

d4b819b

feat: trying adding write permissions in workflow

6c75f65

feat: testing using typescript output when commenting on PRs

4a651e2

feat: echo output from typescript output

13195ed

feat: trying to write directly to process.env.GITHUB_OUTPUT in typesc…

d75b99c

…ript file

feat: using core.setOutput for transferring outputs between steps

a457291

fix: define 'result' in outputs in action.yml

be9cfab

fix: remove deprecated 'set-output' in ci.yml

7d9aa1a

feat: add openapi.json with name and age in CreateCatDto

8fc5980

feat: testing comparing two different openapi files from base and hea…

29cc449

…d ref

chore: try logging out baseFile and headFile

152ded7

chore: ignore openapi.json file when linting and formatting

8cb339b

feat(Eslint): copy eslint.yml file in .github to root for language se…

b7de861

…rvices

refactor: rename typescript files to conform to file naming convention

94890da

fix: diffing openapi procedure follows default code, not the other wa…

5f6f1f7

…y around

feat(Dist): commiting compiled javascript files

f8e1a48

fix: change openapi.json path

6662906

Frontend-jaewon added 3 commits May 26, 2024 14:40

feat(Env): setup development environment

0249fa1

feat(Dev): open server in local dev environment

e5edb17

feat(Markdown): format openapi diffs with markdown

cc6de35

jaychang99 force-pushed the feature/openapi-diff branch from b5a5e31 to cc6de35 Compare May 26, 2024 05:41

fix(Ci): change ci to use markdown version of openapi diff

0a3bf47

jaychang99 added 5 commits May 26, 2024 15:16

feat: resolve all ref-generated openapi json files

e7a1172

feat(Markdown): display Response Parameters in JSON

0007194

feat(Markdown): markdown support for single, 1-depth responses

0b2ea50

chore: comment out unused console.logs

36a3d22

dist: commit distribution files

65bbd70

jaychang99 added 5 commits May 26, 2024 16:37

feat(Markdown): mark nullable fields in responses

b08efaf

feat(Markdown): additional markings for changed request parameters

fda3f2b

fix: fix some added apis being marked as modified

8818bf5

feat: markdown support for nested arrays up to 2 depths

3a7eccb

feat(Dist): commit distribution files

baf7b5a

feat: gracefully handle APIs with no summary and description

0dd221f

jaychang99 added 4 commits May 26, 2024 19:05

feat: markdown support for request bodies

89b5308

feat: gracefully handle cases where no descriptions and examples were…

5ec5f9c

… provided for request bodies

fix: request body's content-type to be the actual MIME type, not sche…

9c3c0aa

…ma's type

feat(Dist): commit distribution code

398d6e7

fix(Markdown): if no response data were provided, do not show

228414d

jaychang99 merged commit 8007455 into main May 26, 2024
17 of 20 checks passed

Features for diffing openapi-compatible json specs. #2

Features for diffing openapi-compatible json specs. #2

Conversation

jaychang99 commented May 25, 2024

github-actions bot commented May 25, 2024

github-actions bot commented May 25, 2024

github-actions bot commented May 25, 2024

github-actions bot commented May 25, 2024

API Differences

ADDED

MODIFIED

DELETED

github-actions bot commented May 25, 2024

API Differences

ADDED

MODIFIED

DELETED

github-actions bot commented May 25, 2024

API Differences

ADDED

MODIFIED

DELETED

github-actions bot commented May 26, 2024

API Differences

ADDED

MODIFIED

DELETED

github-actions bot commented May 26, 2024

API Differences

ADDED

MODIFIED

DELETED

github-actions bot commented May 26, 2024

github-actions bot commented May 26, 2024

github-actions bot commented May 26, 2024

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🗑❌ Removed Endpoints

github-actions bot commented May 26, 2024

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🟩 POST: /cats

Response Parameters

🗑❌ Removed Endpoints

github-actions bot commented May 26, 2024

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🟩 POST: /cats

Response Parameters

🗑❌ Removed Endpoints

github-actions bot commented May 26, 2024

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🟩 POST: /cats

Response Parameters

🗑❌ Removed Endpoints

github-actions bot commented May 26, 2024

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🟩 POST: /cats

Request Body

Response Parameters

🗑❌ Removed Endpoints

github-actions bot commented May 26, 2024

🆕✅ Added Endpoints

🔄⚠️ Modified Endpoints

🟩 POST: /cats

Request Body

🗑❌ Removed Endpoints